<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<![endif]-->
<title>VIM 中文用户手册: 选项设置</title>
<link rel="stylesheet" href="vim-stylesheet.css" type="text/css" />
<link rel="canonical" href="https://yianwillis.github.io/vimcdoc/doc/usr_05.html" />
<script type="text/javascript" src="vimcdoc.js"></script>
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<nav id=banner>
<form action=tags.html target="tag_iframe">
  <input type="text" name="tag" id="tag" placeholder="标签搜索">
</form>
<iframe name="tag_iframe" src=""></iframe>
<a href="help.html">帮助总览</a> &middot;
<hr/>
<a href="quickref.html">快速参考</a> &middot;
<a href="index.html">命令索引</a> &middot;
<a href="eval.html#functions">函数列表</a> &middot;
<a href="quickref.html#option-list">选项列表</a> &middot;
<hr/>
<a href="usr_toc.html">用户手册</a> &middot;
<a href="help.html#reference_toc">参考手册</a> &middot;
</nav>

<header>
<h2>usr_05</h2>
</header>
<article id=outer>
<section class=inner>
<b class="vimtag"> <a name="usr_05.txt">usr_05.txt</a> </b>    适用于 Vim 9.0 版本。   最近更新: 2022年8月

                     <code class="vim">VIM 用户手册 - by Bram Moolenaar</code>
                                <code class="vim">译者</code>: Nek_in、tocer

                             选项设置


Vim 可以按你的需要进行设置。本章告诉你怎样使 Vim 用你指定的选项启动，怎样增加
插件以增强 Vim 的功能；以及怎样进行宏定义。

 <a href="usr_05.html#05.1">05.1</a>   vimrc 文件
 <a href="usr_05.html#05.2">05.2</a>   vimrc 示例解释
 <a href="usr_05.html#05.3">05.3</a>   defaults.vim 文件解释
 <a href="usr_05.html#05.4">05.4</a>   简单键盘映射
 <a href="usr_05.html#05.5">05.5</a>   添加软件包
 <a href="usr_05.html#05.6">05.6</a>   添加插件
 <a href="usr_05.html#05.7">05.7</a>   添加帮助
 <a href="usr_05.html#05.8">05.8</a>   选项窗口
 <a href="usr_05.html#05.9">05.9</a>   常用选项

        下一章:  <a href="usr_06.html#usr_06.txt">usr_06.txt</a>   使用语法高亮
        前一章:  <a href="usr_04.html#usr_04.txt">usr_04.txt</a>   做小改动
          目录:  <a href="usr_toc.html#usr_toc.txt">usr_toc.txt</a> 

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.1">05.1</a> </b>  vimrc 文件                                      <b class="vimtag"> <a name="vimrc-intro">vimrc-intro</a> </b></h4>
可能你已经厌倦了输入那些经常用到的命令了。要让 Vim 用你习惯的设置启动，你可以
把这些设置写到一个叫 vimrc 的文件中。Vim 会在启动的时候执行这个文件里的命令。

如果你已经有 vimrc 文件 (例如，系统管理员已经为你配置好了)，可以这样编辑它: 
<code class="example"></code>
<code class="example">        :edit $MYVIMRC</code>
<code class="example"></code>
如果你还没有 vimrc 文件，请参考  <a href="starting.html#vimrc">vimrc</a>  一节看看你应该在什么地方创建该文件。另
外 ":version" 命令能告诉你 vim 要查找的 "用户 vimrc 文件" 的名字。

对于 Unix 和 Macintosh 系统，总是使用而且也推荐使用如下文件:

<code class="section">        ~/.vimrc </code>

对于 MS-Windows，可以使用下面其中一个文件:

<code class="section">        $HOME/_vimrc </code>
<code class="section">        $VIM/_vimrc </code>

对于初学 vimrc 文件的朋友，建议在开头放上这行: 
<code class="example"></code>
<code class="example">        source $VIMRUNTIME/defaults.vim</code>
<code class="example"></code>
这为 Vim 新用户进行了初始化 (相对于传统 Vi 用户而言)。详见  <a href="starting.html#defaults.vim">defaults.vim</a> 。

vimrc 文件可以包含任何冒号命令。最简单的是设置选项命令。例如，如果你想 Vim 启
动的时候始终开启 <a href="options.html#'incsearch'">'incsearch'</a> 选项，可以在你的 vimrc 文件中加上:

<code class="example">        set incsearch</code>
<code class="example"></code>
要使这个命令生效，你需要重启动 Vim。后面我们还会学到如何不退出 Vim 就能让它生
效。

这一章只解释最基本的东西。想了解更多关于 Vim 脚本的知识，请参见  <a href="usr_41.html#usr_41.txt">usr_41.txt</a> 。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.2">05.2</a> </b>  vimrc 示例解释                                  <b class="vimtag"> <a name="vimrc_example.vim">vimrc_example.vim</a> </b></h4>
在第一章中，我们曾经介绍过怎样用 vimrc 示例文件 (包括在 Vim 发布中) 使 Vim 以
非 vi 兼容模式启动 (参见  <a href="usr_01.html#not-compatible">not-compatible</a> )。这个文件可以在这里找到:

<code class="section">        $VIMRUNTIME/vimrc_example.vim </code>

我们在这一节中介绍这个文件中用到的一些命令。这会对你自行参数设置有一定的帮助。
但我们不会介绍所有的内容。你需要用 ":help" 获得更多的帮助。


<code class="example">        " 获取多数用户想要的缺省值。</code>
<code class="example">        source $VIMRUNTIME/defaults.vim</code>
<code class="example"></code>
这会载入 $VIMRUNTIME 目录里的 "defaults.vim" 文件。这会按照多数用户的喜好设置
Vim。如果你是少数不喜欢的，注释掉这行。其中的命令解释见下:
 <a href="usr_05.html#defaults.vim-explained">defaults.vim-explained</a> 


<code class="example">        if has("vms")</code>
<code class="example">          set nobackup</code>
<code class="example">        else</code>
<code class="example">          set backup</code>
<code class="example">          if has('persistent_undo')</code>
<code class="example">            set undofile</code>
<code class="example">          endif</code>
<code class="example">        endif</code>
<code class="example"></code>
这告诉 Vim 当覆盖一个文件的时候保留一个备份。但 VMS 系统除外，因为 VMS 系统会
自动产生备份文件。备份文件的名称是在原来的文件名上加上 "~" 字符。参见  <a href="usr_07.html#07.4">07.4</a> 

如果可用，也设置 <a href="options.html#'undofile'">'undofile'</a> 选项。会在一个文件中保存多层撤销信息。效果是，当你
改动了文件，退出 Vim，然后再次编辑文件时你可以撤销之前做过的改动。这是很强大很
有用的功能，代价是要保存一个文件。详情可见  <a href="undo.html#undo-persistence">undo-persistence</a> 。

"if" 命令在设置选项的时候非常有用，它使设置命令在某些条件下才执行。更多的内容
请参见  <a href="usr_41.html#usr_41.txt">usr_41.txt</a> 。


<code class="example">        if &amp;t_Co &gt; 2 || has("gui_running")</code>
<code class="example">          set hlsearch</code>
<code class="example">        endif</code>
<code class="example"></code>
它打开 <a href="options.html#'hlsearch'">'hlsearch'</a> 选项，告诉 Vim 高亮上次查找模式匹配的地方。


<code class="example">        augroup vimrcEx</code>
<code class="example">          au!</code>
<code class="example">          autocmd FileType text setlocal textwidth=78</code>
<code class="example">        augroup END</code>
<code class="example"></code>
这使 Vim 在一行长于 78 个字符的时候自动换行，但仅对纯文本文件中有效。这里包括
两个部分。其中 "autocmd FileType text" 定义个自动命令，表示当文件类型被设置为
"text" 的时候，后面的命令自动执行。"setlocal textwidth=78" 设置 <a href="options.html#'textwidth'">'textwidth'</a> 选
项为 78，但仅对本文件有效。

"augroup vimrcEx" 和 "augroup END" 的封装使 "au!" 命令可以删除自动命令。见
 <a href="autocmd.html#:augroup">:augroup</a> 。


<code class="example">        if has('syntax') &amp;&amp; has('eval')</code>
<code class="example">          packadd! matchit</code>
<code class="example">        endif</code>
<code class="example"></code>
如果所需的特性可用，这会载入 "matchit" 插件。这使得  <a href="motion.html#%">%</a>  命令更强大。
 <a href="usr_05.html#matchit-install">matchit-install</a>  有解释。


</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.3">05.3</a> </b>   defaults.vim 文件解释                  <b class="vimtag"> <a name="defaults.vim-explained">defaults.vim-explained</a> </b></h4>
如果用户没有 vimrc 文件，载入  <a href="starting.html#defaults.vim">defaults.vim</a>  文件。如要你创建自己新的 vimrc 文
件，在顶部附近加入此行，以继续使用: 
<code class="example"></code>
<code class="example">        source $VIMRUNTIME/defaults.vim</code>
<code class="example"></code>
或者使用上面解释过的 vimrc_example.vim 文件。

下面解释 defaults.vim 做的事情。


<code class="example">        if exists('skip_defaults_vim')</code>
<code class="example">          finish</code>
<code class="example">        endif</code>
<code class="example"></code>
defaults.vim 的载入可以用这个命令关闭: 
<code class="example">        let skip_defaults_vim = 1</code>
必须在系统 vimrc 文件完成。见  <a href="starting.html#system-vimrc">system-vimrc</a> 。如果有你自己的用户 vimrc，不必如
此，因为不会自动载入 defaults.vim。 
<code class="example"></code>

<code class="example">        set nocompatible</code>
<code class="example"></code>
就像第一章所述，本手册解释在改进的方式下工作的 Vim，因此与 Vi 不完全兼容。要关
闭 <a href="options.html#'compatible'">'compatible'</a> 选项，<a href="options.html#'nocompatible'">'nocompatible'</a> 可以用于完成这个功能。


<code class="example">        set backspace=indent,eol,start</code>
<code class="example"></code>
这指明在插入模式下在哪里允许 <code class="special">&lt;BS&gt;</code> 删除光标前面的字符。逗号分隔的三个值分别指:
行首的空白字符，换行符和插入模式开始处之前的字符。见 <a href="options.html#'backspace'">'backspace'</a>。


<code class="example">        set history=200</code>
<code class="example"></code>
这个命令保存 200 个命令和 200 个查找模式的历史。如果你想 Vim 记住多些或者少些
命令，可以把这个数改成其它值。见 <a href="options.html#'history'">'history'</a>。


<code class="example">        set ruler</code>
<code class="example"></code>
总在 Vim 窗口的右下角显示当前光标位置。见 <a href="options.html#'ruler'">'ruler'</a>。


<code class="example">        set showcmd</code>
<code class="example"></code>
在 Vim 窗口右下角，标尺的右边显示未完成的命令。例如，当你输入 "2f"，Vim 在等
你输入要查找的字符并且显示 "2f"。当你再输入 w，"2fw" 命令被执行，"2f" 自动消
失。

        +-------------------------------------------------+
        |text in the Vim window                           |
        |~                                                |
        |~                                                |
        |-- VISUAL --                   2f     43,8   17% |
        +-------------------------------------------------+
         ^^^^^^^^^^^                  ^^^^^^^^ ^^^^^^^^^^
          <a href="options.html#'showmode'">'showmode'</a>                 <a href="options.html#'showcmd'">'showcmd'</a>  <a href="options.html#'ruler'">'ruler'</a>



<code class="example">        set wildmenu</code>
<code class="example"></code>
在状态行上显示补全匹配。这是按了 <code class="special">&lt;Tab&gt;</code> 后有多于一个匹配的情况。见 <a href="options.html#'wildmenu'">'wildmenu'</a>。


<code class="example">        set ttimeout</code>
<code class="example">        set ttimeoutlen=100</code>
<code class="example"></code>
这使得按 Esc 的生效更快速。通常 Vim 要等待一秒来看看 Esc 是否是转义序列的开
始。如果你使用很慢的远程连接，增加此数值。见 <a href="options.html#'ttimeout'">'ttimeout'</a>。


<code class="example">        set display=truncate</code>
<code class="example"></code>
如果末行被截短，显示 @@@ 而不是隐藏整行。见 <a href="options.html#'display'">'display'</a>。


<code class="example">        set incsearch</code>
<code class="example"></code>
在输入部分查找模式时显示相应的匹配点。见 <a href="options.html#'incsearch'">'incsearch'</a>。


<code class="example">        set nrformats-=octal</code>
<code class="example"></code>
不把零开头的数值识别为八进制数。见 <a href="options.html#'nrformats'">'nrformats'</a>。


<code class="example">        map Q gq</code>
<code class="example"></code>
这定义一个键映射。下一节会介绍更多的相关内容。这将定义 "Q" 命令用来完成与 "gq"
操作符相同的功能，这是在 Vim 5.0 版前 "Q" 命令的作用。如果没有设置这个映射，
"Q" 会启动 Ex 模式，这也许不是你想要的情况。


<code class="example">        inoremap &lt;C-U&gt; &lt;C-G&gt;u&lt;C-U&gt;</code>
<code class="example"></code>
插入模式下的 <code class="keystroke">CTRL-U</code> 删除当前行所有输入的文本。使用 <code class="keystroke">CTRL-G</code> u 会先打断撤销，这样
你可以在插入换行符后撤销 <code class="keystroke">CTRL-U</code>。用 ":iunmap <code class="special">&lt;C-U&gt;</code>" 还原。


<code class="example">        if has('mouse')</code>
<code class="example">          set mouse=a</code>
<code class="example">        endif</code>
<code class="example"></code>
如果可用，允许使用鼠标。见 <a href="options.html#'mouse'">'mouse'</a>。


<code class="example">        vnoremap _g y:exe "grep /" .. escape(@", '\\/') .. "/ *.c *.h"&lt;CR&gt;</code>
<code class="example"></code>
这个映射在可视模式下拷贝已选择的文本并在 C 文件中查找它。你可以看到该映射可以
被用来执行相当复杂的操作。但其本质依然是一个命令序列而已，与你直接输入没有什么
两样。


<code class="example">        syntax on</code>
<code class="example"></code>
打开文件的色彩高亮。见  <a href="syntax.html#syntax">syntax</a> 。

                                                        <b class="vimtag"> <a name="vimrc-filetype">vimrc-filetype</a> </b>  
<code class="example">        filetype plugin indent on</code>
<code class="example"></code>
这启动三个非常灵巧的机制:
1. 文件类型探测
    当你开始编辑一个文件的时候，Vim 会试图确定这个文件的类型。当编辑 "main.c"
    时，Vim 会根据扩展名 ".c" 认为这是一个 C 源文件。当你编辑一个文件前面是
    "#!/bin/sh" 的文件时，Vim 会把它认作 "sh" 文件。文件类型探测用于语法高亮
    和以下另两项。请参见  <a href="filetype.html#filetypes">filetypes</a> 。

2. 使用文件类型相关的插件
    不同的文件需要不同的选项支持。例如，当你编辑一个 "c" 文件，用 <a href="options.html#'cindent'">'cindent'</a> 选
    项来自动缩进就非常有用。这些文件类型相关的选项在 Vim 中是通过文件类型插件
    来实现的。你也可以加入自己的插件，请参见  <a href="usr_51.html#write-filetype-plugin">write-filetype-plugin</a> 。

3. 使用缩进文件
    当编辑程序的时候，行缩进通常可以被自动决定。Vim 用不同的策略处理不同的文件
    类型。请参见  <a href="filetype.html#:filetype-indent-on">:filetype-indent-on</a>  和 <a href="options.html#'indentexpr'">'indentexpr'</a>。


                                <b class="vimtag"> <a name="restore-cursor">restore-cursor</a> </b> <b class="vimtag"> <a name="last-position-jump">last-position-jump</a> </b>  
<code class="example">    autocmd BufReadPost *</code>
<code class="example">      \ if line("'\"") &gt;= 1 &amp;&amp; line("'\"") &lt;= line("$") &amp;&amp; &amp;ft !~# 'commit'</code>
<code class="example">      \ |   exe "normal! g`\""</code>
<code class="example">      \ | endif</code>
<code class="example"></code>
这是又一个自动命令。这回它设置为在读入任何文件之后自动执行。后面那堆复杂的东西
检查 '" 标记是否已被定义，如果是，则跳转到该标记。行首的反斜杠用于把所有语句连
接成一行。这可以避免一行写得太长，
请参见  <a href="repeat.html#line-continuation">line-continuation</a> 。这只在 Vim 脚本文件中有效，在命令行中无效。


<code class="example">        command DiffOrig vert new | set bt=nofile | r ++edit # | 0d_ | diffthis</code>
<code class="example">                  \ | wincmd p | diffthis</code>
<code class="example"></code>
它加入 ":DiffOrig" 命令。在修改过的缓冲区中应用可以看到和原先载入的文件间的差
异。见  <a href="diff.html#diff">diff</a>  和  <a href="diff.html#:DiffOrig">:DiffOrig</a> 。


<code class="example">        set nolangremap</code>
<code class="example"></code>
防止 langmap 选项应用于映射生成的字符上。如果置位 (缺省)，会破坏插件 (但后向兼
容)。见 <a href="options.html#'langremap'">'langremap'</a>。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.4">05.4</a> </b>  简单键盘映射</h4>
映射可以使你把一系列 Vim 命令绑定为一个单独的键。假设你要用一个大括号将一个特
定的单词括起来。例如，把 "amount" 变成 "<code class="special">{amount}</code>"。用 ":map" 命令，就可以让 F5
来完成这个工作。命令如下:

<code class="example">        :map &lt;F5&gt; i{&lt;Esc&gt;ea}&lt;Esc&gt;</code>

        <code class="note">备注</code>:
        在输入这个命令时，<code class="special">&lt;F5&gt;</code> 要用四个字符表示。相似地，输入 <code class="special">&lt;Esc&gt;</code> 不是直接按
        <code class="special">&lt;Esc&gt;</code> 键，而是输入五个字符。读这份手册时请<code class="note">注意</code>这些区别！

让我们来分解一下这个命令:
    <code class="special">&lt;F5&gt;</code>        F5 功能键。这是命令的触发器。当这个键被按下时，相应的命令即被
                执行。

    i{<code class="special">&lt;Esc&gt;</code>     插入 { 字符。<code class="special">&lt;Esc&gt;</code> 键用于退出插入模式。

    e           移动到词尾。

    a}<code class="special">&lt;Esc&gt;</code>     插入 } 到单词尾。

执行 ":map" 命令后，要在单词两端加上 <code class="special">{}</code>，只需要移到单词的第一个字符上并按 F5。

在这个例子中，触发器是单独一个键；它还可以是任何字符串。但若你使用一个已经存在
的 Vim 命令，该命令将不再有效。最好避免出现这种情况。
    一个可用于映射的键是反斜杠。因为你很可能想定义多个映射，那就加上另一个字
符。你可以映射 "\p" 为在单词两端加圆括号，而映射 "\c" 为加花括号，例如:

<code class="example">        :map \p i(&lt;Esc&gt;ea)&lt;Esc&gt;</code>
<code class="example">        :map \c i{&lt;Esc&gt;ea}&lt;Esc&gt;</code>
<code class="example"></code>
你需要在敲入 \ 后，立即敲入 p，以便 Vim 知道它们组成一个命令。

":map" 命令 (无参数) 列出当前已定义的映射，至少会包括普通模式下的那些。更多的
内容参见  <a href="usr_40.html#40.1">40.1</a> 。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.5">05.5</a> </b>  添加软件包                              <b class="vimtag"> <a name="add-package">add-package</a> </b> <b class="vimtag"> <a name="matchit-install">matchit-install</a> </b></h4>
软件包是一组可加入 Vim 的文件。有两种软件包: 可选的和启动时自动载入的。

Vim 发布提供了一些软件包供你选用。例如 matchit 插件。此插件使 "%" 命令跳转到匹
配的 HTML 标签、Vim 脚本中的 if/else/endif 等。很有用，但不后向兼容 (这是为什
么缺省没有打开)。

要开始用 matchit 插件，在 vimrc 文件中加入一行: 
<code class="example">        packadd! matchit</code>
<code class="example"></code>
就这样！重启 Vim 后可以找到此插件的帮助: 
<code class="example">        :help matchit</code>
<code class="example"></code>
这之所以能工作，是因为  <a href="repeat.html#:packadd">:packadd</a>  载入插件时，同时把软件包目录加入
<a href="options.html#'runtimepath'">'runtimepath'</a>，这样就能找到帮助文件了。

网上有多个地方可以找到软件包。它们通常以归档或版本库形式出现。如果是归档，可以
采用以下步骤:
        1. 建立软件包目录: 
<code class="example">                mkdir -p ~/.vim/pack/fancy</code>
           "fancy" 可以是任何你喜欢的名字。要能描述你的软件包。
        2. 在该目录里解压归档。假定归档的顶层目录是 "start": 
<code class="example">                cd ~/.vim/pack/fancy</code>
<code class="example">                unzip /tmp/fancy.zip</code>
           如果归档的目录结构不同，确保最终的路径像这样:
<code class="section">                ~/.vim/pack/fancy/start/fancytext/plugin/fancy.vim </code>
           这里 "fancytext" 是软件包名，这可以是任何其它名字。

关于软件包的详情可见:  <a href="repeat.html#packages">packages</a> 。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.6">05.6</a> </b>  添加插件                                        <b class="vimtag"> <a name="add-plugin">add-plugin</a> </b> <b class="vimtag"> <a name="plugin">plugin</a> </b></h4>
Vim 可以通过插件增强功能。插件其实是一个当 Vim 启动的时候能被自动执行的脚本。
简单地把插件放到你 Vim 的 plugin 目录中就可以使它生效。
<code class="notvi">{仅当 Vim 编译时加入  <a href="various.html#+eval">+eval</a>  特性时才有效}</code>

Vim 中有两种插件:
       全局插件: 用于所有类型的文件
   文件类型插件: 仅用于特定类型的文件

我们将先讨论全局插件，然后涉及文件类型插件  <a href="usr_05.html#add-filetype-plugin">add-filetype-plugin</a> 。


全 局 插 件                                             <b class="vimtag"> <a name="standard-plugin">standard-plugin</a> </b>

当你启动 Vim，它会自动加载一些插件。你不需要为此做任何事。这些插件增加一些很多
人想用的，但由 Vim 脚本实现而非编译进 Vim 中的功能。你可以在帮助索引中找到这些
插件:  <a href="help.html#standard-plugin-list">standard-plugin-list</a> 。还可以参照  <a href="starting.html#load-plugins">load-plugins</a> 。

                                                        <b class="vimtag"> <a name="add-global-plugin">add-global-plugin</a> </b>
你可以加入一个全局插件使得某些功能在你每次使用 Vim 时都被开启。添加一个全局插
件只要两步:
1. 获得一个插件的拷贝
2. 把它塞进合适的目录


获 得 一 个 全 局 插 件

在什么地方可以找到插件？
- 有一些会总是被载入，你可以在 $VIMRUNTIME/plugin 目录中找到它们。
- 有一些与 Vim 一起发布，你可以在 $VIMRUNTIME/macros 目录或其子目录和
  $VIM/vimfiles/pack/dist/opt/ 中找到。
- 从网上下载，<a href="http://www.vim.org">http://www.vim.org</a> 收集了很多。
- 在 Vim 的邮件列表中找:  <a href="intro.html#maillist">maillist</a> 。
- 自己写一个，参见  <a href="usr_51.html#write-plugin">write-plugin</a> 。

某些插件被打包在 vimball 中，参见  <a href="pi_vimball.html#vimball">vimball</a> 。
某些插件可以自动更新，参见  <a href="pi_getscript.html#getscript">getscript</a> 。


使 用 一 个 全 局 插 件

首先阅读插件包括的说明文字，看看有没有什么特殊的限制。然后拷贝到你的插件目录:


<code class="section">        系统            插件目录 </code>
        Unix            ~/.vim/plugin/
        PC              $HOME/vimfiles/plugin 或 $VIM/vimfiles/plugin
        Amiga           s:vimfiles/plugin
        Macintosh       $VIM:vimfiles:plugin

以 Unix 系统为例 (假设你还没有 plugin 目录):

<code class="example">        mkdir ~/.vim</code>
<code class="example">        mkdir ~/.vim/plugin</code>
<code class="example">        cp /tmp/yourplugin.vim ~/.vim/plugin</code>
<code class="example"></code>
就是这样了！现在你可以用这个插件定义的命令了。

除了把这些插件直接放进 plugin/ 目录以外，还可以更好地组织一下，把它们放进
plugin 的单独的子目录中。例如，可以考虑把所有 Perl 插件放置在
"~/.vim/plugin/perl/*.vim"


文件类型插件                     <b class="vimtag"> <a name="add-filetype-plugin">add-filetype-plugin</a> </b> <b class="vimtag"> <a name="ftplugins">ftplugins</a> </b>

Vim 的发布中包括一套针对不同文件类型的插件。你可以用如下命令启用它们:

<code class="example">        :filetype plugin on</code>
<code class="example"></code>
这样就行了！参阅  <a href="usr_05.html#vimrc-filetype">vimrc-filetype</a> 。

如果你缺少某种文件类型的插件，或者你找到一个更好的，你可以自行添加一个。这也只
需两步:
1. 获取一个插件的拷贝
2. 塞到合适的目录。


取 得 文 件 类 型 插 件

你可以在找全局插件的相同地方找到文件类型插件。<code class="note">注意</code>一下插件有没有注明文件类型，
据此你可以知道这个插件是全局的还是文件类型相关的。在 $VIMRUNTIME/macros 中的是
全局插件；文件类型插件在 $VIMRUNTIME/ftplugin 中。


使 用 文 件 类 型 插 件                                 <b class="vimtag"> <a name="ftplugin-name">ftplugin-name</a> </b>

你可以通过把插件文件放到合适的目录中来增加一个插件。目录的名字与前面提过的全局
插件的位置一样，但最后一级目录是 "ftplugin"。假设你找到一个用于 "stuff" 文件类
型的插件，而且你的系统是 Unix。那么，你可以把这个文件用如下命令移入 ftplugin
目录:

<code class="example">        mv thefile ~/.vim/ftplugin/stuff.vim</code>
<code class="example"></code>
如果这个文件已经存在，你可以检查一下两个插件有没有冲突。如果没有，你可以用另一
个名字:

<code class="example">        mv thefile ~/.vim/ftplugin/stuff_too.vim</code>
<code class="example"></code>
这里，下划线用来分开文件类型和其它部分 (这些部分可以由任意字符组成)。但如果你
用 "otherstuff.vim" 就不行了。那是用于 "otherstuff" 类型的文件的。

在 MS-DOS 兼容的文件系统上不能使用长文件名。如果你增加第二个插件，而这个插件超
过 6 个字符，你就没法用了。你可以通过使用另一层目录来解决这个问题:

<code class="example">        mkdir $VIM/vimfiles/ftplugin/fortran</code>
<code class="example">        copy thefile $VIM/vimfiles/ftplugin/fortran/too.vim</code>
<code class="example"></code>
总的来说，一个文件类型相关的插件的名称是:

<code class="example">        ftplugin/&lt;filetype&gt;.vim</code>
<code class="example">        ftplugin/&lt;filetype&gt;_&lt;name&gt;.vim</code>
<code class="example">        ftplugin/&lt;filetype&gt;/&lt;name&gt;.vim</code>
<code class="example"></code>
这里 "<code class="special">&lt;name&gt;</code>" 可以是任何你喜欢的名字。例如，在 Unix 上，"stuff" 文件类型的插件
可以是:

<code class="example">        ~/.vim/ftplugin/stuff.vim</code>
<code class="example">        ~/.vim/ftplugin/stuff_def.vim</code>
<code class="example">        ~/.vim/ftplugin/stuff/header.vim</code>
<code class="example"></code>
这里，<code class="special">&lt;filetype&gt;</code> 部分是相应文件类型的名称。只有对应文件类型的文件才会用这个插
件内的设置。插件的 <code class="special">&lt;name&gt;</code> 部分则不重要，你可以对同一个文件类型使用多个插件。
<code class="note">注意</code> 插件必须以 ".vim" 结尾。


请进一步阅读:
 <a href="filetype.html#filetype-plugins">filetype-plugins</a>       文件类型插件的文档和有关如何避免映射引起的问题。
 <a href="starting.html#load-plugins">load-plugins</a>           全局插件的启动时间。
 <a href="filetype.html#ftplugin-overrule">ftplugin-overrule</a>      控制全局文件类型插件的选项。
 <a href="usr_51.html#write-plugin">write-plugin</a>           如何写插件。
 <a href="filetype.html#plugin-details">plugin-details</a>         关于如何使用插件的信息或者当你的插件不工作的时候如何处
                        理。
 <a href="filetype.html#new-filetype">new-filetype</a>           如果检测新文件类型。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.7">05.7</a> </b>  添加帮助                                        <b class="vimtag"> <a name="add-local-help">add-local-help</a> </b></h4>
如果幸运的话，你安装的插件还会包括帮助文件。我们这里解释如何安装这个帮助文件，
以便你能方便地获得新插件的帮助。
    我们以 "doit.vim" 插件为例。这个插件有一个文档: "doit.txt"。我们先来把该插
件拷贝到合适的位置。这次，我们在 Vim 内完成这个工作。(如果某些目录已经存在你可
以省略一些 "mkdir" 命令。) 
<code class="example"></code>
<code class="example">        :!mkdir ~/.vim</code>
<code class="example">        :!mkdir ~/.vim/plugin</code>
<code class="example">        :!cp /tmp/doit.vim ~/.vim/plugin</code>
<code class="example"></code>
"cp" 命令是基于 Unix 的，MS-Windows 上你可以用 "copy"。

现在在某个 <a href="options.html#'runtimepath'">'runtimepath'</a> 目录中建立一个 doc 目录。

<code class="example">        :!mkdir ~/.vim/doc</code>
<code class="example"></code>
再把帮助文件拷贝进去:

<code class="example">        :!cp /tmp/doit.txt ~/.vim/doc</code>
<code class="example"></code>
现在开始玩技巧了，怎样使 Vim 允许你跳转到新的主题上？用  <a href="helphelp.html#:helptags">:helptags</a>  命令产生一
个本地的 tags 文件即可:

<code class="example">        :helptags ~/.vim/doc</code>
<code class="example"></code>
现在，你可以用这个命令

<code class="example">        :help doit</code>
<code class="example"></code>
从你刚才加上的帮助文件中获得 "doit" 的帮助了。在使用如下命令的时候，可以看到一
个新的条目: 
<code class="example"></code>
<code class="example">        :help local-additions</code>
<code class="example"></code>
本地帮助的标题行被自动的加入到该节了。在那里你可以看到 Vim 添加了那些本地的帮
助文件。你还可以从这里跳转到新的帮助中。

要写一个本地帮助文件，请参考  <a href="usr_51.html#write-local-help">write-local-help</a> 。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.8">05.8</a> </b>  选项窗口</h4>
如果要找一个选项，你可以在这里寻找帮助:  <a href="options.html#options">options</a> 。另一个方法是用如下命令:

<code class="example">        :options</code>
<code class="example"></code>
这会打开一个新窗口，其中给出一个选项的列表，并对每个选项提供一行解释。这些选项
根据种类分组。将光标移到一个主题上然后按 <code class="special">&lt;Enter&gt;</code> 就可以跳转到那里。再按一下
<code class="special">&lt;Enter&gt;</code> 或者 <code class="keystroke">CTRL-O</code> 就可以跳回来。

你可以通过这个窗口改变一个选项的值。例如，移到 "displaying text" 主题。然后把
光标下移到这一行:

<code class="section">        set wrap        nowrap </code>

当你在上面键入回车，这行会改变为:

<code class="section">        set nowrap      wrap </code>

现在，这个选项被关闭了。

这行的上方是对这个选项的简要描述。将光标向上移动一行，然后按 <code class="special">&lt;Enter&gt;</code>，你可以跳
转到 <a href="options.html#'wrap'">'wrap'</a> 的完整帮助，再用 <code class="keystroke">CTRL-O</code> 可以跳回来。

对于那些值为数值或者字符串的选项，你可以编辑它的值，然后按 <code class="special">&lt;Enter&gt;</code> 来启用该
值。例如，把光标移动到下面这行:

<code class="section">        set so=0 </code>

用 $ 移到行尾，再用 "r5" 命令修改为五，然后按 <code class="special">&lt;Enter&gt;</code> 使修改生效。现在如果你移
动一下光标，你会发现在你的光标移到窗口边界前，你的文字就开始滚动了。这就是选项
<a href="options.html#'scrolloff'">'scrolloff'</a> 完成的功能: 它指定在距离边界多远的地方开始滚动文字。

</section><hr class="doubleline" /><section class=inner>
<h4><b class="vimtag"> <a name="05.9">05.9</a> </b>  常用选项</h4>
Vim 中有很多选项。大部分你很少用得上。我们在这个介绍一些常用的。别忘了你可以通
过 ":help" 命令获得更多的帮助。方法是在选项命令前后加上单引号，例如:

<code class="example">        :help 'wrap'</code>
<code class="example"></code>
如果你搞乱了一个选项，你可以通过在选项后加上一个 (&amp;) 把它恢复到默认值。例如:

<code class="example">        :set iskeyword&amp;</code>
<code class="example"></code>
禁 止 回 绕 行

Vim 通常会对长行自动回绕，以便你可以看见所有的文字。但有时最好还是能让文字在一
行中显示完。这样，你需要左右移动才能看到一整行。以下命令可以关闭行的回绕:

<code class="example">        :set nowrap</code>
<code class="example"></code>
当你移动到那些不能显示的文字上，Vim 会自动向右滚动让你看到后面的文字，要一次滚
动十个字符，这样就行了:

<code class="example">        :set sidescroll=10</code>
<code class="example"></code>
这个命令不改变文件中的文本，只改变显示方式。


移 动 命 令 换 行

很多命令只能在一行中移动。你可以通过 <a href="options.html#'whichwrap'">'whichwrap'</a> 选项改变它。如下命令把这个选
项设为默认值:

<code class="example">        :set whichwrap=b,s</code>
<code class="example"></code>
这样，当光标处于行首时用 <code class="special">&lt;BS&gt;</code> 键可以回到前一行的结尾；当处于行尾时用 <code class="special">&lt;Space&gt;</code>
键可以移动到下一行的行首。

要允许 <code class="special">&lt;Left&gt;</code> 和 <code class="special">&lt;Right&gt;</code> 键也能这样，可以用这个命令:

<code class="example">        set whichwrap=b,s,&lt;,&gt;</code>
<code class="example"></code>
这只在普通模式中有效，要在插入模式中使 <code class="special">&lt;Left&gt;</code> 和 <code class="special">&lt;Right&gt;</code> 也有效，可以:

<code class="example">        :set whichwrap=b,s,&lt;,&gt;,[,]</code>
<code class="example"></code>
还有一些可以用的标志位，参见 <a href="options.html#'whichwrap'">'whichwrap'</a>。


显 示 TAB 键

文件中有 TAB 键的时候，你是看不见的。要把它显示出来:

<code class="example">        :set list</code>
<code class="example"></code>
现在 TAB 键显示为 ^I，而 $显示在每行的结尾，以便你能找到可能会被你忽略的空白字
符在哪里。
    这样做的一个缺点是在有很多 TAB 的时候看起来很丑。如果你使用一个有颜色的终
端，或者使用 GUI 模式，Vim 可以用高亮显示空格和 TAB。使用 <a href="options.html#'listchars'">'listchars'</a> 选项:

<code class="example">        :set listchars=tab:&gt;-,trail:-</code>
<code class="example"></code>
现在，TAB 会被显示成 "&gt;---" ("-" 的个数不定) 而行尾多余的空白字符显示成 "-"。
看起来好多了，是吧？


关 键 字

<a href="options.html#'iskeyword'">'iskeyword'</a> 选项指定哪些字母可以出现在一个单词中:

<code class="example">        :set iskeyword</code>
<code class="section">         iskeyword=@,48-57,_,192-255 </code>

"@" 表示所有字母。"48-57" 表示 ASCII 字符 48-57 ，即数字 0 到 9。"192-255" 是
可显示的拉丁字符。
    有时你希望横线也是关键字，以便 "w" 命令会把 "upper-case" 看作是一个单词。
你可以这样做:

<code class="example">        :set iskeyword+=-</code>
<code class="example">        :set iskeyword</code>
<code class="section">         iskeyword=@,48-57,_,192-255,- </code>

看一下新的值，你会发现 Vim 自动在 "-" 前面加了一个逗号。
    要从中去掉一个字符，用 "-="。例如要排除下划线:

<code class="example">        :set iskeyword-=_</code>
<code class="example">        :set iskeyword</code>
<code class="section">         iskeyword=@,48-57,192-255,- </code>

这回，逗号又自动被删除了。


显 示 消 息 的 空 间

当 Vim 启动的时候，在屏幕底部有一行被用于显示消息。当消息很长的时候，多余的部
分会被截断。这样你只能看到一部分。或者文字自动滚动，你要按 <code class="special">&lt;Enter&gt;</code> 来继续。你
可以给 <a href="options.html#'cmdheight'">'cmdheight'</a> 选项赋一个值，用来设定显示消息所用的行数。例如:

<code class="example">        :set cmdheight=3</code>
<code class="example"></code>
这样意味着你用于编辑文字的空间少了，所以这实际上是一种折衷。

</section><hr class="doubleline" /><section class=inner>
<h4></h4>下一章:  <a href="usr_06.html#usr_06.txt">usr_06.txt</a>   使用语法高亮

版权: 参见  <a href="usr_01.html#manual-copyright">manual-copyright</a>   vim:tw=78:ts=8:noet:ft=help:norl:
</section>
</article>
<footer>
Generated by vim2html
</footer>
</body>
</html>
